Setting up a Plan
You define Plans through the HR Manager portal in Sage People. You'll then make them available to Planners through WX.
Resolution
- Select the Compensation Planning tab.
-
Select New.
Sage People displays the Compensation Plan setup page.
-
Complete the fields as follows:
Field What to enter Plan Name The name of the Plan. This name displays in WX, so make it meaningful to Planners. -
Complete the fields in the Information section as follows:
Tip The Start Date and End Date control the period of time the Plan is available for Planners to edit it in WX. System Administrators can amend this after you create the Plan, but consider these dates carefully when you create a Plan.Field What to enter Start Date The date when the Plan starts. End Date Offset A default two or four week period when the Planner completes the Plan. If you select an offset, the End Date automatically populates. End Date A date in the future and after the Start Date. -
Complete the fields in the Compensation Planning section as follows:
Field What to enter Compensation Plan Type The type of Plan. Select:
- Salary Planning to create a plan for creating new Salary Records
- Bonus Planning to create a plan for bonus awards
- Both checkboxes to create a combined salary and bonus plan
Other fields appear depending on your selection.
-
If you select Salary Planning as the Compensation Plan Type, Sage People displays the Salary Planning section. Complete the fields in as follows:
Field
What to enter Effective Date The default date when awards in the Plan come into effect. To let Planners change the Effective Date for individual Team Members, select the Allow Planners to edit effective date in Planning Worksheet checkbox. The Effective Date will be the Start Date of the New Salary Records you create when you commit the plan.
Allow Planners to edit effective date in Planning Worksheet Checkbox. Select if you want to give managers who complete Salary Plans the option to change the default Salary Effective Date for Team Members.
Salary Reason Picklist. Select the picklist and choose the reason to apply as a default to Team Members in the Plan. The picklist includes all active values you hold in the Change Reason field on the Salary object.
You can display the default Salary Reason in the Plan and enable Planners to change the Salary Reason for individual Team Members. Select the Allow Planners to edit the salary change reason in Planning Worksheet checkbox.
If you leave Salary Reason blank, no default Salary Reason displays in the Plan. If Planners leave the field blank in the Plan, Salary Records default to display the content of the Custom Label Change_Reason_Compensation_Planning. You can let Planners select a Reason when you don't set a default. Select the Allow Planners to edit the salary change reason in Planning Worksheet checkbox.
Allow Planners to edit the salary change reason in Planning Worksheet Checkbox. Select:
- If you've set a default reason and you want Planners to view and change the default Salary Reason for individual Team Members
- If you haven't set a default reason, and you want Planners to select a Salary Reason for each Team Member
-
If you select Bonus Planning as the Compensation Plan Type, Sage People displays the Bonus Planning section. Complete the fields in as follows:
Field
What to enter Effective Date The date when awards in the Plan come into effect. This updates the pay date on the Bonus Record that you create when you commit the Plan.
Allow Planners to edit effective date in Planning Worksheet Select if you want to let managers who complete Bonus Plans change the default Bonus Effective Date.
Bonus Reason Select the reason to apply to bonus payments you make as a result of the Bonus Plan.
The Reason picklist defines the reasons available on the Bonus object.
-
Select Save & Next to display the Fields tab.
-
Add fields on the Select Fields page to give Planners more information. If the default fields are sufficient, you don't need to add any more. See Default Plan display in WX.
Select fields available to add to a Plan from the Team Member and Employment Record objects. This provides information Planners use when planning compensation awards. The system doesn't list all fields in those objects for selection.
- Use Search Fields in each section to find fields you want to add to the Plan.
- Select a field in Available Fields and use the right arrow to add it to Selected Fields.
- Select a field in Selected Fields and use the left arrow to return it to Available Fields.
- Select a field in the Reorder Columns section and use the up/down arrows to specify the display order in the Plan. Note
The system lists any fields you remove from the Team Member or Employment Record objects while building the Plan in a message. Move the missing fields from Selected Fields to Available Fields and select Save & Next again. The system removes the missing fields from Available Fields automatically.
-
Select Save & Next to display the Formulas tab.
-
Select the formulas you want to use:
- If you selected Salary Planning as the Plan type, select from the Salary Formulas picklists
- If you selected Bonus Planning as the Plan type, select from the Bonus Formulas picklists
Note The system takes the formula fields that are available here from the Compensation Package. Be sure you've added the relevant formula fields to the package so they're available to select.When you select a formula, the page expands to display the Formula Summary and the API Name of the Formula field:
The Formula Summary contains the Help Text you loaded for the Formula field.
NoteThe system lists any formulas you removed from the Employment Record while building the Plan in a message. Ensure you remove the formula from the Compensation Planning Configure page. Then go to the Formulas tab, select an alternative formula, and select Save & Next again.
-
Select Save & Next to display the Planners tab:
-
Select a Top Planner for the Plan. The Top Planner defaults to the CEO of your organization. It's the person who submits the main Plan and has access to view all details within a Plan. Be sure this is an appropriate person.
Start typing the name of the Top Planner in the Search field to display a list of matching names. Select the person you want.
Type at least three characters to start the search.
The person you chose replaces the previous Top Planner.
Change the Top Planner as many times as you need until you're ready to plan.
-
Select Planners for the Plan. A Planner is a Manager with one or more direct reports who you include in a Plan. Planners display by Policy and the Planners tab automatically includes all Policies with Managers you assigned. If a Policy has no Managers, the system doesn't include it in the list of Policies.
Note If you deselect a Planner, all of their direct reports show as reports under the next manager in your reporting hierarchy.Planners display with checkboxes corresponding to the type of Plan. A Plan including Bonus and Salary displays two columns of checkboxes.
Select a policy to display all managers you assigned to the Policy. By default, the system selects all Managers with Employment Status set to Active and Has Left showing False as Planners.
If you want to mix Planner responsibilities, create two Plans; one for salary, one for bonus. For example, some Planners contribute salary recommendations, some contribute just bonus, some contribute both salary and bonus.
To create a Plan for a few Planners, you can deselect all Planners. Do this by unchecking the Select All checkboxes at the head of the column, then:
- Use the Search field to find a specific manager.
- Select the Bonus, Salary, or both checkboxes next to a manager to make them a Planner for the type of Plan.
If you're creating a Plan for most managers to use and want to remove just a few:
- Use the Search field to find a specific manager.
- Clear the Bonus, Salary, or both checkboxes next to a manager to remove them as a Planner for the type of Plan.
If a Planner leaves during the planning setup process, when you select Ready to Plan, Sage People displays a notification message. You need to remove the Planner manually from the list of Selected Managers. If you don't appoint a replacement manager immediately, the system assigns the leaver's immediate manager. It does this automatically as the Planner for the leaver's direct reports.
- Check your Plan. You can select the tabs or Back to return to a page and make any required changes.
-
When you're happy with your Plan, select Ready to Plan
Compensation Planning asks you to confirm.
-
Select Ready to Plan.
Compensation Planning performs several checks:
- There's only one Team Member without a manager, with Employment Status set to Active and Has Left showing False. This is typically the CEO, the person at the top of the corporate hierarchy
- All active Team Members with a manager have a Current Salary. The CEO can have, but doesn't need, a Current Salary
- All Current Salary values have an associated currency
- The org has only one exchange rate with Rate set to 1.00 to determine the reporting currency
When all checks are successful, two batches trigger:
Ready to Plan batches
- The Ready Plans batch sets the Plan status to Ready
- The Start Plans batch runs at the time you select on the Compensation Planning Configure page. Or when the Ready Plans batch finishes and the Plan Start Date is today or in the past. The Start Plans batch makes all Plans with a Start Date of today available to the Planners you select. The Plan status changes to In Progress
- An error message can display if the system finds any data issues. The message details the issue for you to correct and click Ready to Plan again
- The Plan becomes read only and you can't edit it
-
To display a summary of your Plan, select the Plan on the Compensation Planning Home page.
Default Plan fields
Compensation Plans display to Planners in WX. They include a range of default fields that display in sections for Team, Salary, and Bonus. See Default Plan display in WX
Planners can control many features of the plan that displays, including:
- Changing the order of the fields that display
- Choosing which fields to display or hide
- Pinning fields in a non-scrolling area
- Filtering the Plan display based on the values of some fields
See Change your Plan view in WX
Plans display to Planners using one line for each Team Member. The WX display includes:
- Overall Plan values at the top of the Plan
- A Team section if the Plan includes child Plans for direct reports who are also Planners. The Team section includes total values for their teams. These are sums of values you entered in the Planner's child Plan for each Team Member. The system updates values for child Plans dynamically. This means a Planner viewing a parent Plan while a user updates the child Plan sees the values changing
- Lines for Team Members who aren't Planners, with values for the Team Member
During setup, you can select other fields to display for Planners from a subset of those in the Team Member and Employment Record objects. By default, additional fields display in the order you select, and immediately after the Team section. Planners can tailor their own Plan views to move or hide the default additional fields. See Change your Plan view in WX
View the Plan Summary page
You can display a Plan Summary for all Plans beyond draft status. To display a summary of your Plan:
-
Select the Compensation Planning tab.
Sage People displays the Compensation Planning Home page.
-
On the Home page, select the Plan Name.
Sage People displays the Plan Summary page.
The page includes a head area with top-level information about the plan. Further information about the Plan displays under Plan Details, Planners, Formulas, and Plan Fields tabs.
Page head
| Field | Description |
|---|---|
| Plan Status |
|
| Start Date | Date when the Plan becomes available for Planners in WX. |
| End Date | The date after which the Plan is no longer available for Planners in WX. |
| Last refreshed Date | Date a user last refreshed the Plan. |
| Button: Delete | Selectable for Plans in Draft, In Progress, Ready, Submitted, or Approved status. |
| Button: Clone | Selectable for Plans in any status. |
| Button: Refresh Plan | Selectable if the Plan is In Progress. Pulls the latest values into the Plan. |
Further information about your Plan displays under Plan Details, Planners, Formulas, and Plan Fields tabs.
Plan Details
Information relevant to the type of Plan.
For Salary Planning:
|
Field |
Description |
|---|---|
| Effective Date | Date when the salary award takes effect. |
| Salary Reason | Default reason for salary awards made through this Plan. For example, Regular increase, Promotion. The Change Reason picklist field on the Salary object stores the available values. |
For Bonus Planning:
| Field | Description |
|---|---|
| Effective Date | Date when the bonus award takes effect. |
|
Bonus Reason |
Default reason for Bonus awards made through this Plan. For example: Performance, Commission. The Reason picklist field on the Bonus object stores the available values. |
Planners
The Top Planner and Planners you select for this Plan with checkboxes indicating the Plan Type(s) available to each Planner. The list includes an indicator against Planners who haven't yet submitted their Plans.
|
Field |
Description |
|---|---|
| Top Planner | Name. |
| Selected Planners |
Manager name. Not submitted indicator: Plan type. |
Formulas
Formulas used in your Plan. If you don't use a formula type, for example Bonus Exclusion, the field displays Not Set.
|
Field |
Description |
|---|---|
| Salary Projection (for Salary Plans) |
Formula Field Label. |
| Salary Exclusion (for Salary Plans) |
Formula Field Label. |
| Salary Eligibility (for Salary Plans) |
Formula Field Label. |
| Bonus Projection (for Bonus Plans) |
Formula Field Label. |
| Bonus Exclusion (for Bonus Plans) |
Formula Field Label. Formula Summary - the Help Text you enter for the bonus exclusion formula field. API Name of the bonus exclusion formula field. |
| Bonus Eligibility (for Bonus Plans) |
Formula Field Label. Formula Summary - the Help Text you enter for the bonus eligibility formula field. API Name of the bonus eligibility formula field. |
Plan Fields
Fields you add to your Plan and to the default fields. If you didn't add any fields, this tab is empty.
|
Field |
Description |
|---|---|
| Team member fields... | Fields from the Team Member object you added to your Plan for display on the planning worksheet. |
| Employment Record fields... | Fields from the Employment Record object you added to your Plan for display on the planning worksheet. |
Clone a Plan
Cloning a Plan copies the settings in the original Plan. Any settings deleted since you created the original Plan don't copy. You can clone a Plan in any status. You can clone only one Plan at a time.
Cloning from the home page
-
Select the Compensation Planning tab.
-
Select the checkbox beside the Plan you want to clone.
-
Select Clone
Help Center Home asks you to confirm.
- Select Clone to confirm. The copied Plan lists on the Compensation Planning Home page with Draft status. The name of the plan is the same as the plan you clone, with "Copy of..." at the start.
- Select the Plan name to open it and make the changes you need. You can rename the Plan to remove the "Copy of..." prefix.
The plan copies the following values:
- Plan Name
- Start Date and End Date
- Plan Type
- Effective Date and Effective Date Planner override setting
- Any other fields you select for display on the Plan
- Depending on the Plan type, Salary, Bonus or both Projection Formulas
- Selected Planners
- Select Save & Next.
Cloning from the Plan Summary page
If you clone a Plan from the Plan Summary page, you can check the Plan settings before cloning.
-
Select the Compensation Planning tab.
Sage People displays the Compensation Planning Home page.
-
On the Home page, select the Plan Name.
Sage People displays the Plan Summary page.
-
On the Plan Summary page, select Clone.
Sage People asks you to confirm.
-
Select Clone to confirm.
The Plan you copy lists on the Compensation Planning Home page with Draft status.
Refresh a Plan
If you change:
-
Team Member
-
Salary or Bonus Records
-
Projection, eligibility, or exclusion formulas
...you can pull the information you've updated into Plans with status In Progress.
For changes you made to the Salary or Bonus Eligibility formulas you assigned to the Plan, if the change means:
-
A Team Member becomes eligible for a Salary or Bonus award -
Refresh adds them to the Plan as an eligible Team Member
-
A Team Member ceases to be eligible for a Salary or Bonus award -
Refresh marks them as ineligible and Planners can't enter new values for that award type
For changes you made to the Salary or Bonus Exclusion formulas you assigned to the Plan, if the change means:
-
A Team Member becomes excluded from a Salary or Bonus award -
Refresh removes them from the Plan
If the Team Member was a Planner, their direct reports pass to the one-up Planner
-
A Team Member becomes included for a Salary or Bonus award -
Refresh adds them to the Plan
Important If the Team Member is a Planner, Refresh doesn't add them as a Planner.
Refresh a plan
- Select the Compensation Planning tab.
-
Expand the Actions dropdown menu beside the Plan you want to refresh and select Refresh Plan.
The system asks you to confirm.
- Select Confirm.
You can also select Refresh Plan from the plan Summary page. See View the Plan Summary page
View Plan history
You can view changes made to a Plan except changes made to Salary Reason. All other changes record from when you first made the Plan available to Planners. The Change History page shows the most recently requested Plan values.
- Select the Compensation Planning tab.
-
Expand the dropdown menu for the Plan you want to view and select Change History.
Sage People displays the Change History page for the Plan.
Change History columns
-
To view change details for a Team member, select the Expand arrow beside the Team Member's name.
-
To view changes for Team Members reporting to a Planner on your team, select the Expand icon beside the Planner's name.
Change History Details columns
| Column | Description |
|---|---|
| Team Members |
Team Member affected by the change. Plan type, Salary, or Bonus, indicates after the Team Member's name. If a Plan includes Salary and Bonus, and you change both values for a Team Member, they have two lines in the Change History. One for Salary, One for Bonus. |
| Requested Amount | The most recently requested salary or bonus. If there's no requested salary, this column is blank. |
| Percentage |
Displays if the Planner changes the percentage value. If they change the Requested Amount and the system calculates percentage values, this column is blank. For a Salary: The percentage difference between the current salary and the requested salary. For a Bonus: The percentage value of the current salary to pay as a bonus award. |
| Effective Date | The Effective Date a Planner entered. If a planner hasn't modified the Effective Date, this column is blank. |
| Changes | The number of changes a user made to the Plan for each Team member line. |
| Column | Description |
|---|---|
| Date & Time |
When a user made the change. |
| Planner | Planner who made the change. |
| Action | Change type. |
| Field Change |
Field showing a value that a user changed. |
| From | Original value of the field. If this is the first change to the field, this column is blank. |
| To | New value of the field. |
Delete a Plan
Deleting a Plan deletes all the planning data it contains. You can' restore a Plan you delete.
You can delete a Plan with status:
-
Draft
-
Ready
-
In Progress
-
Submitted
-
Approved
You can delete several Plans at once.
You can't delete a Plan with status:
-
Committed, or a partially committed Plan
- Select the Compensation Planning tab.
- Select the checkboxes beside the Plans to delete.
- Select Delete and Delete.
Plan notifications
The system generates and sends automated notifications. It does this when users take actions and a plan passes through the stages of the Compensation Planning process. These notifications are hard-coded in the system. Action Events or Workflows don't generate them, and they don't use email templates. You can't stop notifications from generating or sending.
Notifications use custom labels to build their content. This lets you modify and localize the detail of the messages they contain.
For each action triggering a notification, this section includes:
-
A description of purpose
-
Custom label names and default values you include in the notification
You can focus the Custom Labels display. Create a view with Categories contains compensation and Short Description contains email.
Action: Submitted
Email the system sends to the top planner assigned to a plan. Includes the name of planner who submitted and the number of remaining plans they need to submit. This is before the top planner can submit the overall plan.
|
Custom label name |
Custom label default value |
|---|---|
|
Submit_Email_Intro |
{0} has submitted their plan. |
|
Submit_Email_Outstanding_Planners |
The following Planners have Plans outstanding |
|
Submit_Email_No_Outstanding_Planners |
No Plans are outstanding – you can now submit your Plan. |
Action: Commited
User email
Email the system sends to the user who committed the plan. Includes salaries they haven't committed because they're subject to conditions. For example, pending HR Requests or future-dated salary records.
| Custom label name | Custom label default value |
|---|---|
|
Salary_Conflict_Email_Subject |
Conflicts were detected between Compensation Planning output and other future-dated salary awards or pending HR Requests. No new Salary Records were created for Team Members with conflicts. |
|
Salary_Conflict_Email_Intro |
Conflicts were detected between Compensation Planning output and other future-dated salary awards or pending HR Requests. No new Salary Records were created for Team Members with conflicts. |
|
Salary_Conflict_Email_Pending_HR_Requests |
The following Team Members have pending HR Requests affecting their salary: |
|
Salary_Conflict_Email_Pending_Salaries |
The following Team Members have future-dated Salary Records: |
|
Salary_Conflict_Email_Outro |
Please investigate and resolve conflicts as necessary, then re-run the batch to commit the changes. |
Planner email
Emails the system sends to all planners. For each planner, the email includes their team members who have new salary or bonus records created.
| Custom label name | Custom label default value |
|---|---|
|
Plan_Committed_Email_Subject |
Plan Committed |
|
Plan_Committed_Email_Body |
Your {0} plan has been committed. |
|
Plan_Committed_Email_Body_Bonus |
New Bonus records are being created and will apply from their effective dates for the following team members: |
|
Plan_Committed_Email_Body_Salary |
New Salary records are being created and will apply from their effective dates for the following team members: |
Action: Refreshed
Emails the system sends to planners who had changes in their plans. Each email includes team members who have changes to their Team Member or Employment Records affecting planning.
| Custom label name | Custom label default value |
|---|---|
| Refresh_Batch_Notification | Please review your Compensation Plan |
|
Salutation This custom label is widely used across Sage People. Editing the value will have an impact beyond Compensation Planning. |
Hi {0}, |
|
Refresh_Batch_New_Projection_Formula |
Your Compensation Planning Administrator has refreshed your Plan {0}. The suggested salary for each of your direct reports may have changed. Please check your Plan to see if further changes are needed. If you have already submitted your Plan, you will need to resubmit it after your changes. |
|
Refresh_Plan_Batch_Intro_Mail |
Your Compensation Planning Administrator has refreshed your Plan {0}. Please check your plan to see if you need to make changes. If you have already submitted your Plan, you will need to resubmit it after your changes. |
|
Refresh_Batch_Changed_Sub_Budgets |
Changes were made to your team budget or to the budget of these Planners on your team. |
|
Refresh_Batch_Team_Member_Changes |
Changes were made to these Team Members. |
|
Thanks This custom label is widely used across Sage People. Editing the value will have an impact beyond Compensation Planning. |
Thanks |
|
Sage_People_Signature This custom label is widely used across Sage People. Editing the value will have an impact beyond Compensation Planning. |
The Sage People team |
Action: Ready to Plan Failure
Email the system sends to the user who committed the plan when an unexpected data-related error occurs.
| Custom label name | Custom label default value |
|---|---|
|
Send_Batch_Email_Subject |
{0} failure |
| Send_Batch_Email_Introduction | The {0} has failed for the {1} Plan. The {1} Plan has been reset to Draft status |
|
Salary_Error_Email_Intro_Not_Records_Inserted |
The {0} has failed for the {1} Plan. No salaries have been changed and the {1} Plan has been reset to Approved status. |
|
Salary_Error_Email_Intro_Records_Inserted |
The {0} has failed for the {1} Plan. Some salaries have been changed and the {1} Plan has been set to Partially Committed status. |
|
Plan_Ready_Batch_Error_Email_Intro |
The {0} has failed for the {1} Plan. The {1} Plan has been reset to Draft status. |
|
Refresh_Batch_Error_Email_Intro |
The {0} has failed for the {1} Plan. No changes have been made to the {1} Plan and the Plan status is unchanged. |
|
Batch_Error_Cause |
Cause: {0} |
|
Batch_Error_Message |
Message: {0} |
|
Batch_Error_StackTrace |
StackTrace: {0} |
|
Send_Batch_Email_Outro |
To help find the cause the following information has been sent to Sage People Support: |
Action: In Progress
Notification displays on screen when the status changes to In Progress.
| Custom label name | Custom label default value |
|---|---|
| Status_in_Progress | In Progress |



















